Command Reference for TNC1-Ver2  (TNC1.HLP Ver2.0)
═COMMAND══════ARG════DEFAULT═══════════DESCRIPTION═══
*
* Created 01JAN92 by N. J. McMillan (VK2XCI)
* Parts of this file Copyright 1985, R.E. Raikes, (WA8DED).
*
* This file was created for use with the paKet (c) program only.
*
* The above two lines must remain in this file as is. They are used
* by the program for the headings on the display window.
* The first describes the type of TNC this file is set up for and
* is displayed on the bottom of the TNC help window.
* The second is the headings for the TNC help window and this line
* should line up with the "header" data in this file.
*
* Each help item starts with its "header" which is identified by
* the "@" in the first column. This is then followed by a variable
* number of lines of detailed help for that item.
*
* Any line in this file beginning with an "*" is treated as a comment
* and is ignored by the paKet program.
*
******************************************************************************
@A          0,1          1       Enable/disable Auto LINEFEED to terminal
Parameters:
      0 - Auto LINEFEED disabled.
      1 - Auto LINEFEED enabled.

The 'A' command is used to control the insertion of a LINEFEED  after
a CARRIGE RETURN  to the terminal. This parameter is stored in NOVRAM.
******************************************************************************
@B          1-15         6       Select terminal baudrate.
Parameters:
     1 = 50               2 = 75              3 = 110
     4 = 135              5 = 150             6 = 300
     7 = 600              8 = 1200            9 = 1800
     10 = 2400,          11 = 3600           12 = 4800
     13 = 7200           14 = 9600           15 = 19200

This value is stored in NOVRAM. It must be 'PERMED'after being set and
will then take effect following a 'RESET'. Rates above 4800 may not be
reliable with sustained input (commands or information) from a host
computer due to the slow CPU clock rate and non-vectored interupt
architecture.
******************************************************************************
@C          Cs1 [Cs2 - 9]        CONNECT path via optional repeaters.
Parameters:
      Cs1     = Destination callsign.
      Cs2 - 9 = Optional repeater callsigns. (Up to 8 digipeaters)
Examples;
      C VK2XCI              CONNECT to VK2XCI direct
      C VK2XCI VK2RGF       CONNECT to VK2XCI thru VK2RGF

The 'C' command is used to initiate a link connection. Note that NO 'v'
or 'Via'is used between the destination callsign and the digipeater call-
signs.

A 'C'command may be issued on a STREAM already in use to change the digi-
peater callsigns, but not the destination callsign.

A 'C' command issued when STREAM 0 is selected sets the unproto path.
Attempting to connect to more than one station on the same STREAM is not
permitted.
******************************************************************************
@D          none                 Initiate link DISCONNECT.
Parameters:
      None

The 'D' command is used to initiate a link disconnection. A 'D' command
issued during the establishment or disestablishment of a link connection
will immediately cause a return to the disconnected state.

A 'D' command issued on a disconnected STREAM will re-initialise the
connection dependent parameters to the values stored in STREAM 0.
******************************************************************************
@E          0,1                  Disable/enable input ECHO
Parameters:
      0 = ECHO disabled.
      1 = ECHO enabled.


The 'E' command is used to enable or dissable the echoing of input  to
the terminal. This parmeter is stored in NOVRAM.

When using paKet you should set ECHO OFF.

paKet will display the characters you type in a different colour or
intensity to help you distinguish your transmissions from the received
data.
*****************************************************************************
@F          1 - 15       4       Frame acknowledge time (in seconds).
Parameters:
      'n' = 1 - 15  is the interval used to compute the time before an
            unacknowledged packet is retransmitted.

The formula used is     time(secs) = F*{(2*number of digipeaters) + 1}

A separate fram ack. time is maintained for for each STREAM.
The value stored in STREAM 0 is used to initialise each connection
after a reset or disconnection. This value is stored in NOVRAM.
******************************************************************************
@G          0,1                  Get information/link status (Host mode)
Parameters:
      0 = Get information.
      1 = Get link status.

The 'G' command is used to interrorgate virtual TNC channels when HOST
MODE is enabled.If no parameter is given the next chronological item
(information or status) is returned. This command is invalid in terminal
mode.
******************************************************************************
@H          50 - 9600    1200    HDLC baud rate
Parameters:
      'n' = 50 - 9600. Non-standard values are rounded down to the next
            possible baud rate.

Used with no parameter, 'H' displays the actual HDLC baud rate in use.
HDLC baud rates of up to 9600 are supported if fast clock mode is enabled.
This parameter is stored in NOVRAM.
******************************************************************************
@I          callsign     blank   Sets the TNC source callsign
parameters:
      Callsign = Alpha-numeric string, being station callsign.

      Example   <esc> C VK2XCI

After the source callsign has been entered it should be PERMED for use
during subsequent operation. Changing the source callsign while connected
is not permitted.
******************************************************************************
@JHOST      0,1          0       Enable terminal or host mode
Parameters:
     0 = Terminal mode
     1 = Host mode

For paKet this MUST BE set to 0, terminal mode.

Host mode is intended to provide a user interface suitable for operation
under the control of a host processor. This is fully discussed in the
documentation:-    AX.25 Version 2
                    Multi-channel
                    TNC  FIRMWARE
                   Copyright 1985, Ronald E. Raikes  (WA8DED)
******************************************************************************
@K          1,2                  Calibrate TNC
Parameters:
      1 = Frequency counter.
      2 = Tone levels and null.

The frequency counter mode will display the measured frequencies on the
terminal. When each mode is selected, jumper settings and appropriate
adjustment points are displayed. Values shown in parenthesis are the
target values for 1200 baud operation.
******************************************************************************
@L          0 - 4                Display link status.
Parameters:
      'n' selects STREAM to display.
      If no parameter is given, all streams are displayed.

Information displayed includes the connection path, number of received
frames not yet displayed, number of send frames not yet transmitted,
number of transmitted frames not yet acknowledged and the current retry
count.

A '+' character preceding the STREAM number indicates the currently
selected STREAM.
******************************************************************************
@M          NIUSCRT+-    UI      Set frame monitor mode.
Parameters:
      N = none
      I = I (information) frames.
      U = UI (un-numbered information) frames.
      S = Supervisory frames.
      C = Monitor While connected.
      R = Monitor received (addressed to) frames.
      T = Monitor transmitted (addressed from) frames.
      + = Callsigns to be include (max of 8)
      - = Callsigns to be excluded (max of 8).

The + and - parameters may not be used together. If either is used it
must be the last parameter, followed by the callsign list.A + or -
without a callsign will empty the list.

This parameter is stored in NOVRAM.
******************************************************************************
@N          0 - 255      10      Set number of retries.
Parameters:
      'n' = Number of retries before a link failure is assumed.

This represents the number of times a frame will be transmitted without
receiving an appropriate acknowledgement, before a link failure is
assumed and a DISCONNECT issued.

A separate value for 'N' is maintained for each connected STREAM. The
value stored in STREAM 0 is used to initialise each STREAM after a
DISCONNECT or RESET.

This value is stored in NOVRAM.
******************************************************************************
@O          1 - 7        4       Sets number of outstanding 'I' frames
Parameters:
      'n' = Max number of unacknowledged 'I' frames outstanding at
            any one time.

A separate value for 'I' is maintained for each STREAM. The value stored
in STREAM 0 is used to initialise each STREAM after a DISCONNECT or RESET.

This allows the TNC to send up to 7 FRAMES without waiting for an ACKNOW-
LEDGE for each individual frame. When the ACKNOWLEDGE is sent, only those
FRAMES which were missed are retransmitted.

With appropriate setting of 'F'(to allow the TNC to assemble and send the
next FRAME), the transfer of long files over a good circuit is greatly
expidited.
******************************************************************************
@PERM                            Save current settings to NOVRAM.
Parameters:
      None. Immediate command.

This command writes the current settings to NOVRAM, (Non-Volitile RAM)
overwritting the previous contents. These are then the new DEFAULT
settings next time the TNC is powered up, or 'QRES' issued.
******************************************************************************
@QRES                            Restart firmwear
Parameters:
      None. Immediate command

This is identical to a HARDWARE RESET. Entire RAM content is erased and
the TNC restarted using the values stored in NOVRAM.

Note that any messages etc stored in RAM will be lost, the screen will be
cleared, the sign on message will appear.and any connections lost.
******************************************************************************
@R          0,1          0       Enable/disable DIGIPEATING.
Parameters:
      0 = DIGIPEATING disabled.
      1 = DIGIPEATING enabled.

This parameter is stored in NOVRAM.
******************************************************************************
@S          0 -4         1       Select the current STREAM number.
Parameters:
      'n' = STREAM on which communication will take place

This parameter is governed by the setting of 'Y', the number of STREAMS
allowed.

If STREAM 0 is selected and a 'C' command issued, the UNPROTO path is set.
This is the path which UI FRAMES are sent. eg CQ, BEACON etc. See also 'U'

Example:
      <esc> S0    Sets TNC to STREAM 0
      <esc> C [text] Cs1...Cs9  (where [text] is up to chars and Cs1...Cs9
                                 DIGIPEATER path).
      eg...<esc> C BEACON VK2RGF

The default path for STREAM 0 is CQ.
******************************************************************************
@T          0 -127       30      Transmitter key-up delay. (10ms)
Parameters:
      'n' * 10 ms is delay between keying the transmitter and sending
          a FRAME

This allows time for the transmitter to come up to power and settle on
frequency befor a FRAME is sent. This allows for slow PLL-lock, relay
switching and valve transmitters with inverter power supplies!

If problems are experienced with high FRAME REJECT rates, set this to 127
and slowly reduce it to the lowest value allowing reliable communication.
******************************************************************************
@U          0 - 2        0       Enable/disable Unattended/QST mode
Parameters:
      0  [text]            Unnattended mode disabled
      1  [text]            Unnattended mode enabled
      2  'n'  text         BEACON mode enabled. 'n' is the interval in
                           in minutes from 1 to 65,535.

When UNNATTENDED mode is enabled, the TNC will send [text] in response
to a connect. The connecting station may then leave a brief message,
which will be stored in RAM. The message may be retrieved using the
'L' command.
Example;
      <esc>U1 Unnattended at the moment, please leave a brief message
              and disconnect. Norm.

When BEACON mode is selected, the user supplied text will be sent at
intervals set by 'n', to the UNPROTO  path set in STREAM 0. (See 'S'
command).
Example:
      <esc>U2 15 Propagation test. Please QSL to VK2XCI. 73 de Norm.

This will result in the text "Propagation...Norm." being sent to the
UNPROTO path every 15 minutes. Interval and text must be supplied
each time BEACON mode is selected. Please use this mode sparingly as it
may cause annoyance, or at worst degrade network performance.

Selecting UNNATTENDED or BEACON mode does not interfere with the
ability CONNECT to another station in the usual manner on any STREAM.
******************************************************************************
@V          1,2          2       Select protocol version.
Parameters:
      1 = Selects Version 1 protocol.
      2 = Selects Version 2 protocol.

Leave this set to version 2. In any case the TNC will change to the
version being used by the other station. A separate value is maintained
for each STREAM, the value in STREAM 0 is stored in NOVRAM and is the
value initialised to each STREAM following DISCONNECT or RESET.
******************************************************************************
@W          0 -127       16      DIGIPEAT wait interval
Parameters:
      'n' = 10ms increments

This is the time interval that the TNC waits from receiving a packet,
to retransmitting that same packet, when DIGIPEATING.
******************************************************************************
@X          0,1          1       Enable/disable transmitter PTT.
Parameters:
      0 = Disable PTT.
      1 = Enable PTT.

Command used in CALIBRATE routine etc to allow testing etc of TNC with-
out causing network congestion/annoyance.
******************************************************************************
@Y          0 - 4        1       Maximum number of STREAMS allowed
Parameters:
     'n' =  number of STREAMS to open.

This sets the maximum number of simultaneous connections which may be
made. It should be set to the same value as set in the paKet config-
uration file under "Max number of communications windows".
******************************************************************************
@Z           0 - 3       3       Terminal flow control and handshaking.
Parameters:
      0 = flow disabled, XON/XOFF disabled.
      1 = Flow enabled, XON/XOFF enabled.
      2 = Flow disabled, XON/XOFF disabled.
      3 = flow enabled, XON/XOFF disabled.

If flow control is enabled, output to the terminal will be inhibited
while entering commands or information. If XON/XOFF handshaking is
enabled, CRT scrolling may be stopped using <CONTROL-S> and started
with <CONTROL-Q>.

Flow control and handshaking should be disabled (0) while the TNC is
operated without a terminal, to avoid consuming buffers in the TNC.

Refer to the section on Hardware vs Software Handshaking in the paKet
manual.  If you are using a full RS-232 cable, you should disable flow and
specify HW handshaking in paKet.

This parameter is stored in NOVRAM.
******************************************************************************
@@B                              Display number of free buffers.
Parameters:
     'n' = Number of free buffers. available.

Software Maintainence command.
******************************************************************************
@@C         0,1          0       Enable/disable fast CPU clock.
Parameters:
     0 = Fast clock disabled.
     1 = Fast clock enabled.

Software maintenance command.
******************************************************************************
@@P         0 - FF       0F      Protocol ID.
Parameters:
      none.

This Value should not be altered. It identifies the protocol in use on
each STREAM.
******************************************************************************
@@S                              Display currnt link state.
Parameters:
      none.

Software maintenance command.
******************************************************************************
@@T2        0 -255       100     Software timer #2 period.
Parameters:
      'n' = period in 10ms increments

This sets the period from when the TNC receives an INFORMATION FRAME, to
when it issues the RESPONSE FRAME. This delay allows multiple FRAMES to
be ACKNOWLEDGED with a single response.
******************************************************************************
@@T3        0 -32767     18000   Software timer #3 period.
Parameters.
      'n' = period in 10ms increments.

Timer T3 is used to maintain link integrity. If there is no activity
during the T3 period, the TNC will poll the distant station to verify
that it is still connected.
******************************************************************************
